Skip to content

Jacob/template catalog#105

Open
jacobecox wants to merge 8 commits intomainfrom
jacob/template-catalog
Open

Jacob/template catalog#105
jacobecox wants to merge 8 commits intomainfrom
jacob/template-catalog

Conversation

@jacobecox
Copy link
Contributor

Added overview page to Templates section, this includes an overview of templates, how to install (added pages for each method - UI, CLI, Terraform, Pulumi), and a list of available templates. Navigation has a drop down group of installation methods and a list of templates. Added a new template page for CockroachDB (as a sample) and modified ESS page to resemble the same layout and details.

@MajidAbuRmila
Copy link
Contributor

MajidAbuRmila commented Feb 12, 2026

Here are my notes per page:

Overview

  • List the available templates first, then list the available install methods. It doesn't make sense to direct users to install a template before they even know which templates are available

Cockroach Template

  • Remove the words "static placement" from the GVC description under "What Gets Created"
  • If there are no actual prerequisites, remove the Prerequisites section entirely or rename it to something like "Install" or something
  • Add an icon and a short description to each of the install method cards (UI, CLI, Terraform, Pulumi).
  • Rework the External References section, each reference should be its own card with an icon, laid out in a 2x2 grid (2 columns, 2 rows)

UI Install Steps

  • The first step ("Select a Template") packs too much information into a single step. Break it up into smaller, more digestible steps
  • Add the missing step for clicking the Create Template Release button after selecting a template from the catalog.
  • Don't call it the "install page", the user lands on a page for creating a template release after clicking Create Template Release and it doesn't explicitly say that this page is called install page
  • Replace "this item will be set in the values file" with something clearer, e.g., "you will need to configure the GVC name in the values file if no GVC select is available" or something
  • Mention the Template option, which provides raw YAML manifests that users can manually apply. Also mention that the CLI install command is shown below and link to install through the CLI page
  • The button label is Install App, not "Install." Also mention that the user is redirected to the release page after installation

CLI Install Steps

  • The current instructions are incorrect and need to be reworked. The Helm packages repo does not contain all templates and their versions, that is a separate issue that needs to be fixed first, but for now the cpln helm install command must include specific tags to be recognized as a marketplace/catalog release. Reference the CLI command shown on the "Create Template" page in the UI for the correct format. Please test the updated command end-to-end

Pulumi / Terraform

  • The Pulumi snippets are broken because of indentation, indentation matters in Pulumi, every code snippet needs to be tested and verified before merging. For both Terraform and Pulumi, we should recommend that users define their values.yaml as files within their project rather than inline and we show usage for Terraform and for each Pulumi lanague

This PR is still not ready to merge yet as we still need to add more templates other than CockroachDB, cc @hakan-controlplane, we need you to do a second review

@hakan-controlplane
Copy link
Contributor

hakan-controlplane commented Feb 20, 2026

Move External Secret Syncer out of the templates section to be under overview in the sidebar as it is not a template. Also remove it from the "Available Templates" list in the overview

It is a template

@jacobecox
Copy link
Contributor Author

The docs have been updated as per the requests checked above. I left the "install page" wording since "Create Template Release" is instructed immediately before making the wording less ambiguous. I can add all the templates to the docs as I have the time but it will be a longer process.

@MajidAbuRmila
Copy link
Contributor

The docs have been updated as per the requests checked above. I left the "install page" wording since "Create Template Release" is instructed immediately before making the wording less ambiguous. I can add all the templates to the docs as I have the time but it will be a longer process.

Thank you Jacob, on a second review I took I have taken the following notes:

Overview

  • Under Available Templates, let's say templates repo instead of template repo.
  • Let's change the Getting Started heading to something related to how to install.

UI Install

  • For the 6th step, let's replace it with the following: "Click Install App to deploy the template. Control Plane will provision the required resources based on your configuration and will automatically navigate you to the newly created release."

CLI

  • Under Choose a Template step, let's also change it to "templates repo".
  • In the Install the Release step, the required marketplace tags are still missing from the cpln helm install command. This item was previously marked as resolved, but the command has not yet been updated. Please align it with the CLI format shown on the Create Template page in the UI and validate the flow end-to-end.
  • In the Replace below change the description of the <TEMPLATE> to the following "The path to the template chart (for example, /cockroachdb/versions/1.1.0).".
  • Under View Releases, the current description is inaccurate. The cpln helm list command lists all installed releases in the organization, not only template/marketplace releases. Please replace the existing text with "List all installed releases in your organization".
  • Please remove this under Upgrade "Replace or <VALUES_FILE> with updated paths.", no need for it.
  • At the end let's link to our helm guide that is under How-to Guides with a card.
  • Terraform

    Pulumi

    External Secret Syncer

    • Let's change the icon for Doppler card at the bottom as it is partially cut off.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants